Show:

CGSGParticleEmitter Class

Extends CGSGNode
Defined in: src\animation\class.particles.js:157
Module: ParticleSystem
Parent Module: Animation

A particle emitter for the cgSceneGraph Particle System

Constructor

CGSGParticleEmitter
(
  • node
  • region
  • nbParticlesMax
  • velocity
  • angle
  • speed
  • speedThreshold
  • outflow
)

Defined in src\animation\class.particles.js:157

Parameters:

Methods

_createParticle
(
  • index
)
private

Defined in src\animation\class.particles.js:367

create a new particle, and add it to the emitter

Parameters:
addForce
(
  • vector
  • ttl
)
Object public

Defined in src\animation\class.particles.js:423

Add a force to the emitter

Parameters:
Returns:
Object:
initParticle
(
  • particle
  • index
)
public

Defined in src\animation\class.particles.js:398

Parameters:
removeForce
(
  • force
)
public

Defined in src\animation\class.particles.js:437

Remove a previously added force

Parameters:
render
(
  • context
)
public

Defined in src\animation\class.particles.js:319

Parameters:
reset () public

Defined in src\animation\class.particles.js:301

reset the animation

start () public

Defined in src\animation\class.particles.js:283

start the animation

stop () public

Defined in src\animation\class.particles.js:292

stop the animation

updateParticle
(
  • particle
)
Boolean public

Defined in src\animation\class.particles.js:380

Parameters:
Returns:
Boolean:

Properties

angle Number

Defined in src\animation\class.particles.js:207

angle range of emission. a particle is emitted in the this.direction vector + or - this.angle/2 angle.

gravity Object

Defined in src\animation\class.particles.js:253

Gravity Force added by default with the addForce method

nbParticlesMax Number

Defined in src\animation\class.particles.js:193

number max of particles out of the emitter on 1 frame

onInitParticle Function

Defined in src\animation\class.particles.js:267

Callback when reinit for 1 particle

Default: null

onInitParticlesEnd Function

Defined in src\animation\class.particles.js:274

Callback when reinit all particles is done

Default: null

onUpdateParticleEnd Function

Defined in src\animation\class.particles.js:260

Callback on end of update for 1 particle

Default: null

region CGSGRegion

Defined in src\animation\class.particles.js:187

the region from where the particles are emitted

speed Number

Defined in src\animation\class.particles.js:217

speed of a particle

speedThreshold Number

Defined in src\animation\class.particles.js:226

threshold to randomize and add to the speed of a particle